####################################################################

NF Tech Equiping ship with cloakingSFX and installing New Sounds

####################################################################



###################### Introduction #################################

Thanks for downloading Now this little guide comes in two parts
First Adding a New Sound  and second Equiping a ship with an Existing sound

####################################################################
####################################################################

Installing a new Sound: 

First Go to Scripts/Custom/Autoload and Copy "__init__.py" Rename the copy 
to something else like "NewShipCloakingSounds.py" 

*IMPORTANT* 

Do NOT Rename the original "__init__.py" or delete this file


Now open the file Erase everything in the file and add the following to it: 

import App
import Foundation

Foundation.SoundDef([Path to Sound],    [Usage Name],  1)    # Cloak Sound
Foundation.SoundDef([Path to Sound],    [Usage Name],  1)    # DeCloak Sound


*** Where [Path to Sound] is the Path to the sound you intend to use 
*** Where [Usage Name] is the Name you are going to use for the sound to help see Example 1


Save the File and you are done Next you need add the sound to the ship......


################## Adding Sound to a Ship ##########################

I assume you've already installed your ship and it has either come 
with a plugin file or you've created your own ship plugin 
so you can use it:

1: Begin by opening your ship plugin file [Scripts/Custom/Ships/]

2. Now scroll down till you find the following line

Foundation.ShipDef.[ShipName] = Foundation.FedShipDef(abbrev, species, { '

*** Where [ShipName] is the Name of the ship



Now below this line add the following (For Help See Example 2): 

Foundation.ShipDef.[ShipName].CloakingSFX   = ["Cloaking Sound"]
Foundation.ShipDef.[ShipName].DeCloakingSFX = ["DeCloaking Sound"]


*** Where [ShipName] is the Name of the ship
*** Where ["Cloaking Sound"] and ["DeCloaking Sound"] are the sound Names

Examples (Note:   For Example Files See Folder Examples)
         (Note 2: For a List of Cloak SOunds already shipped with CloakSFX see "CloakingSFXAutoload.py" in the Autoload Directory)


########################## Example 1 ###############################
####################################################################


import App
import Foundation


Foundation.SoundDef('sfx\Custom\CloakingSFX\enter warp.wav',    'eysionCloak',  1)
Foundation.SoundDef('sfx\Custom\CloakingSFX\exit warp.wav',     'eysionDeCloak', 1)


####################################################################
####################################################################



########################## Example 2 ###############################
####################################################################


Foundation.ShipDef.Elysion = Foundation.FedShipDef(abbrev, species, { 'name': longName, 'iconName': iconName, 'shipFile': shipFile, "SubMenu": SubMenu })
Foundation.ShipDef.Elysion.CloakingSFX   = "RomulanCloak"
Foundation.ShipDef.Elysion.DeCloakingSFX = "RomKlingDeCloak"

####################################################################
####################################################################